Fix docs, scripts, and CI/CD accuracy across the project#51
Draft
Fix docs, scripts, and CI/CD accuracy across the project#51
Conversation
- README.md: fix include/ dir name, section numbering, executable paths, build commands, Docker instructions, size output example, add gcovr entry - scripts/run.sh: move shebang to line 1, remove dead code and non-existent private/genid.py reference, quote variable in command -v - scripts/gen_coverage_lcov.sh: use -DENABLE_COVERAGE=ON to match CMakeLists, make xdg-open conditional for headless environments - scripts/gen_coverage_gcovr.sh: same coverage flag and xdg-open fixes - tests/README.md: fix typo "statememts" -> "statements" - CI/CD workflow: add continue-on-error to experimental clang-tidy step - Dockerfile: add missing git package Co-authored-by: urbytes21 <118428350+urbytes21@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update README.md documentation and check CI/CD scripts
Fix docs, scripts, and CI/CD accuracy across the project
Mar 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README, shell scripts, CI workflow, and Dockerfile had several inaccuracies — wrong paths, broken references, inconsistent CMake flags, and a misplaced shebang.
README.md
includes/→include/, added missing dirs to project hierarchycd build; cmake ..→cmake -S . -B build(matches scripts)cpp_lab_project_test→cpp_lab_project_unit_testcd build(Dockerfile is at root)sizeoutput: added missing hex column, fixed filenamescripts/run.sh
./private/genid.py$toolincommand -vcheckscripts/gen_coverage_lcov.sh, gen_coverage_gcovr.sh
-DCMAKE_CXX_FLAGS="--coverage -O0 -g"→-DENABLE_COVERAGE=ON(uses the CMake option already defined inCMakeLists.txt)xdg-openmade conditional — prints path instead of failing in headless/CI environmentsCI/CD workflow
continue-on-error: trueto the clang-tidy step (already annotated as experimental, but was still failing the pipeline)Dockerfile
gitpackagetests/README.md
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.